PHP设计模式之工厂方法模式(Factory Method)

文章转载地址：http://blog.samoay.me/post/view/27

简单工厂(静态工厂方法)

说到真正的“工厂方法模式”之前，需要先看一下“简单工厂”，简单工厂实际上还算不上一种模式，我们可以把它叫做一种常用写法。例如我们比较常用的数据库操作，我们为了适配不同的数据库引擎，可能分别编写了具体的数据库操作类（当然这些类都实现了统一的接口）：

//统一的操作接口，保证对于外部调用是透明统一的

interface DbInterface{
    public function connect(Array $params=array());
    public function query($sql);
    public function insert($table, $record);
    public function update($table, $record, $where);
    public function delete($table, $where);
}

class Mysql implements DbInterface{
    //...省略具体实现
}


class SqlServer implements DbInterface{
    //...省略具体实现
}


class Sqlite implements DbInterface{
    //...省略具体实现
}


//我们具体的应用中，一般只会使用一种数据引擎，一般会根据一个全局的配置
class GlobalConfig{
    const DBENGINE = "mysql";
}


//原始的方法每次需要使用数据库的时候都使用if或者switch方法判断配置并实例化需要的数据库操作类。
//这样代码中会出现大量重复的代码，那么我们应该将相应的代码迁移到一个统一的类当中，这就是简单工厂了
class DbFactory{
    //一般为了调用便利，不需要初始化这个工具类，将方法定义为静态方法
    public static function factory(){
        if (GlobalConfig::DBENGINE=='mysql'){
            return new Mysql();
        }elseif (GlobalConfig::DBENGINE=='sqlserver'){
            return new SqlServer();
        }elseif (GlobalConfig::DBENGINE=='sqlite'){
            return new Sqlite();
        }
    }
}


//需要使用时
$db = DbFactory::factory();
$db->connect(...);//当然，我们可以把connect操作在类的构造方法中去实现了

简单工厂只是工厂方法模式抽象中的一个部分，但是因为其结构简单而又实用（将复杂的初始化操作封装起来了），在PHP中应用广泛，Zend Framework中随处可见，如Cache、Captcha、Ldap等等。

工厂方法模式

工厂方法模式，是指通过实现一个类似现实中“工厂”的模式，用来生产我们想要的产品即具体类的实例。通过工厂方法模式，我们先定义一个创建对象的接口（抽象工厂），然后将具体类（产品）的实例化推迟到了子类（具体工厂）中实现。那么在我们项目中如何具体应用呢？

假如我们的产品需要提供数据导出的功能，目前我们提供两种格式的导出：txt文本和pdf文档。安装工厂方法模式，我们这样来实现：

//抽象工厂
<?php
interface ExportFactory{
    //这里的config我们用于传入导出的一些需要的特殊配置，与默认配置进行合并
    //如果是自己的项目框架内使用，除了通过方法传入参数，还可以通过配置文件的方式
    public function create($config=array());
}


<?php
//Txt格式具体工厂
class TxtExportFactory implements ExportFactory{
    public function create($config=array()){
        return new TxtExportHelper($config);
    }
}


<?php
//Pdf格式具体工厂
class PdfExportFactory implements ExportFactory{
    public function create($config=array()){
        return new PdfExportHelper($config);
    }
}


<?php
//抽象产品
interface ExportHelper{
    /**
     * @param $source 导出数据源
     */
    public function export($source);
}


<?php
//具体Txt导出类
class TxtExportHelper implements ExportHelper{
    private $config;


    public function __construct($config==array()){
        $defaultConfig = array(
            'maxsize' => 1024*1024*5,
            'rootdir' => './export/',
            'prefix' => 'ex_',
            'coding' => 'UTF-8',
            'linechars' => 100,
        );
        $this->config = array_merge($defaultConfig, $config);
    }


    public function export($source){
        //具体导出逻辑，这里省略
    }
}


<?php
//具体Pdf导出类
class PdfExportHelper implements ExportHelper{
    private $config;


    public function __construct($config=array()){
        $defaultConfig = array(
            'maxsize' => 1024*1024*5,
            'rootdir' => './export/',
            'prefix' => 'ex_',
            'width' => 1800,
            'height' => 3200,
            'margin' => 200,
        );
        $this->config = array_merge($defaultConfig, $config);
    }


    public function export($source){
        //具体导出逻辑，这里省略
    }
}


<?php
//Client调用，假定我们有一个博客文章阅读的Controller（MVC）如下：
class NovelController{
    public function actionView($id){
        //html页面显示$id内容
    }


    public function actionVote($id){
        //给$id内容投票
    }


    public function actionExportTxt($id){
        //导出$id的内容
        $source = $this->modle->getDataByPk($id);//假定调用Model提取数据
        $factory = new TxtExportFactory();
        $this->export($factory);//txt方式完全使用默认配置
    }


    public function actionExportPdf($id){
        //导出$id的内容
        $source = $this->modle->getDataByPk($id);//假定调用Model提取数据
        $config = array(
            'width' => 1200,
            'height' => 1800,
        );
        $factory = new PdfExportFactory();
        $this->export($factory, $source, $config);
    }


    //将具体的导出处理独立
    private function export(ExportFactory $factory, $source, $config=array()){
        $exportHelper = $factory->create($config);
        $exportHelper->export($source); 
    }


    //省略更多方法
}

关于“工厂方法模式”相对于“简单工厂”的优势

实际上，上诉“工厂方法模式”完全可以通过“简单工厂”去实现，那么我们为什么要抽象出“抽象工厂”和“具体工厂”这两个角色呢？很简单，还是为了更好的实现封装，说到这里不得不说软件设计中的一条重要原则：开放-封闭原则。就是说，我们的设计应该只对扩展开放（可以通过扩展现有结构实现新的功能），而应该对修改封闭（不应该修改已有的类和设计）。

那么针对我们封装的这个功能：实现数据的多文件格式导出，如果使用“简单工厂”去实现去实现，例如ExportFactory如下：

class ExportFactory{
    pubic static function create($type){
        switch ($type){
            case 'txt':
                return new TxtExportHelper();
            case 'pdf':
                return new PdfExportHelper();
            default:
                throw new Exception('export type not suppert');
        }
    }
}

如果我们现在业务扩展，需要实现新的格式Word文档的导出，那么，我们不得不修改上述ExportFactory类，增加一条case语句：

...
case 'word':
    return new WordExportHelper();
...

这就表示，我们修改了已有的类ExportFactory。随着业务的不断扩展，我们可能还需要经常修改这个类，来增加诸如Epub格式、mobi格式等等的支持。而且，当case分支越来越多，这个ExportFactory将变得更加难于维护。那如果使用“工厂方法模式”来实现呢，我们就只需要新增WordExportFactory和WordExportHelper这两个类，客户端（Client）就可以直接使用了。

可能有的人会想，那我新增了两个类不算“修改”吗？我在客户端NovelController中增加对Word格式处理的调用不算修改吗？对于前者，在软件设计中不能称为修改（没有修改已经有的类和设计结构），而是扩展（通过实现ExportFactory和ExportHelper接口扩展已有的功能）。对于后者，的确是修改，但是这种修改是延迟到了客户端（调用者）的，所以对于我们定义的功能“实现数据的多文件格式导出”并没有修改，而这种延迟对于底层设计者和最终调用者都是有好处的。